/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.shardingsphere.elasticjob.lite.lifecycle.api;

import org.apache.shardingsphere.elasticjob.lite.lifecycle.domain.DagBriefInfo;

import java.util.List;

/**
 * Dag operate api.
 *
 **/
public interface DagOperateAPI {
    /**
     * Pause the running dag, do not trigger next job.
     *
     * @param dagName dag name
     * @return toggle success?
     */
    boolean toggleDagPause(String dagName);

    /**
     * Resume the pause dag.
     *
     * @param dagName dag name
     * @return toggle success?
     */
    boolean toggleDagResume(String dagName);

    /**
     * Start the dag, trigger the first job.
     *
     * @param dagName dag name
     * @return toggle success?
     */
    boolean toggleDagStart(String dagName);

    /**
     * Stop the pause dag, can not resume.
     *
     * @param dagName dag name
     * @return toggle success?
     */
    boolean toggleDagStop(String dagName);

    /**
     * when the dag state fail, rerun the fail job .
     *
     * @param dagName dag name
     * @return toggle success?
     */
    boolean toggleDagRerunWhenFail(String dagName);

    /**
     * query dag list.
     *
     * @return dag info list
     */
    List<DagBriefInfo> getDagList();

    /**
     * get dag's job and it's dependencies.
     *
     * @param dagName dag name
     * @return dag info list
     */
    List<DagBriefInfo> getDagJobDependencies(String dagName);
}
